home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / catD / copyreq.z / copyreq
Encoding:
Text File  |  1998-10-30  |  8.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ccccooooppppyyyyrrrreeeeqqqq((((DDDD4444))))                                                        ccccooooppppyyyyrrrreeeeqqqq((((DDDD4444))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_oooo_pppp_yyyy_rrrr_eeee_qqqq - STREAMS transparent _iiii_oooo_cccc_tttt_llll copy request structure
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_ssss_tttt_rrrr_eeee_aaaa_mmmm_...._hhhh_>>>>
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_dddd_dddd_iiii_...._hhhh_>>>>
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      The _cccc_oooo_pppp_yyyy_rrrr_eeee_qqqq structure contains the information necessary to process
  17.      transparent _iiii_oooo_cccc_tttt_lllls.
  18.  
  19. UUUUSSSSAAAAGGGGEEEE
  20.      The _cccc_oooo_pppp_yyyy_rrrr_eeee_qqqq structure is used in _MMMM______CCCC_OOOO_PPPP_YYYY_IIII_NNNN and _MMMM______CCCC_OOOO_PPPP_YYYY_OOOO_UUUU_TTTT messages.  The
  21.      module or driver usually converts an _MMMM______IIII_OOOO_CCCC_TTTT_LLLL or _MMMM______IIII_OOOO_CCCC_DDDD_AAAA_TTTT_AAAA message into an
  22.      _MMMM______CCCC_OOOO_PPPP_YYYY_IIII_NNNN or _MMMM______CCCC_OOOO_PPPP_YYYY_OOOO_UUUU_TTTT message.  The _cccc_oooo_pppp_yyyy_rrrr_eeee_qqqq structure is thus overlaid on
  23.      top of the _iiii_oooo_cccc_bbbb_llll_kkkk(D4) or _cccc_oooo_pppp_yyyy_rrrr_eeee_ssss_pppp(D4) structure.  The stream head
  24.      guarantees that the message is large enough to contain the different
  25.      structures.
  26.  
  27.    SSSSttttrrrruuuuccccttttuuuurrrreeee DDDDeeeeffffiiiinnnniiiittttiiiioooonnnnssss
  28.      The _cccc_oooo_pppp_yyyy_rrrr_eeee_qqqq structure contains the following members:
  29.  
  30.      _iiii_nnnn_tttt      _cccc_qqqq______cccc_mmmm_dddd_;;;;       _////_**** _iiii_oooo_cccc_tttt_llll _cccc_oooo_mmmm_mmmm_aaaa_nnnn_dddd _****_////
  31.      _cccc_rrrr_eeee_dddd______tttt   _****_cccc_qqqq______cccc_rrrr_;;;;       _////_**** _uuuu_ssss_eeee_rrrr _cccc_rrrr_eeee_dddd_eeee_nnnn_tttt_iiii_aaaa_llll_ssss _****_////
  32.      _uuuu_iiii_nnnn_tttt______tttt   _cccc_qqqq______iiii_dddd_;;;;        _////_**** _iiii_oooo_cccc_tttt_llll _IIII_DDDD _****_////
  33.      _cccc_aaaa_dddd_dddd_rrrr______tttt  _cccc_qqqq______aaaa_dddd_dddd_rrrr_;;;;      _////_**** _cccc_oooo_pppp_yyyy _bbbb_uuuu_ffff_ffff_eeee_rrrr _aaaa_dddd_dddd_rrrr_eeee_ssss_ssss _****_////
  34.      _uuuu_iiii_nnnn_tttt______tttt   _cccc_qqqq______ssss_iiii_zzzz_eeee_;;;;      _////_**** _nnnn_uuuu_mmmm_bbbb_eeee_rrrr _oooo_ffff _bbbb_yyyy_tttt_eeee_ssss _tttt_oooo _cccc_oooo_pppp_yyyy _****_////
  35.      _iiii_nnnn_tttt      _cccc_qqqq______ffff_llll_aaaa_gggg_;;;;      _////_**** _ffff_oooo_rrrr _ffff_uuuu_tttt_uuuu_rrrr_eeee _uuuu_ssss_eeee _****_////
  36.      _mmmm_bbbb_llll_kkkk______tttt   _****_cccc_qqqq______pppp_rrrr_iiii_vvvv_aaaa_tttt_eeee_;;;;  _////_**** _mmmm_oooo_dddd_uuuu_llll_eeee _pppp_rrrr_iiii_vvvv_aaaa_tttt_eeee _dddd_aaaa_tttt_aaaa _****_////
  37.      The _cccc_qqqq______cccc_mmmm_dddd field is the _iiii_oooo_cccc_tttt_llll command, copied from the _iiii_oooo_cccc______cccc_mmmm_dddd field of
  38.      the _iiii_oooo_cccc_bbbb_llll_kkkk structure.  If the same message is used, then the _cccc_qqqq______cccc_mmmm_dddd field
  39.      directly overlays the _iiii_oooo_cccc______cccc_mmmm_dddd field (that is, it need not be copied.)
  40.  
  41.      The _cccc_qqqq______cccc_rrrr field contains a pointer to the user credentials.  It is copied
  42.      from the _iiii_oooo_cccc______cccc_rrrr field of the _iiii_oooo_cccc_bbbb_llll_kkkk structure.  If the same message is
  43.      used, then the _cccc_qqqq______cccc_rrrr field directly overlays the _iiii_oooo_cccc______cccc_rrrr field (that is,
  44.      it need not be copied.)
  45.  
  46.      The _cccc_qqqq______iiii_dddd field is the _iiii_oooo_cccc_tttt_llll ID, copied from the _iiii_oooo_cccc______iiii_dddd field of the
  47.      _iiii_oooo_cccc_bbbb_llll_kkkk structure.  It is used to uniquely identify the _iiii_oooo_cccc_tttt_llll request in
  48.      the stream.  If the same message is used, then the _cccc_qqqq______iiii_dddd field directly
  49.      overlays the _iiii_oooo_cccc______iiii_dddd field (that is, it need not be copied.)
  50.  
  51.      For an _MMMM______CCCC_OOOO_PPPP_YYYY_IIII_NNNN message, the _cccc_qqqq______aaaa_dddd_dddd_rrrr field contains the user address from
  52.      which the data are to be copied.  For an _MMMM______CCCC_OOOO_PPPP_YYYY_OOOO_UUUU_TTTT message, the _cccc_qqqq______aaaa_dddd_dddd_rrrr
  53.      field contains the user address to which the data are to be copied.  In
  54.      both cases, the _cccc_qqqq______ssss_iiii_zzzz_eeee field contains the number of bytes to copy.
  55.  
  56.      The _cccc_qqqq______ffff_llll_aaaa_gggg field is reserved for future use and should be set to 0 by
  57.      the module or driver.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccooooppppyyyyrrrreeeeqqqq((((DDDD4444))))                                                        ccccooooppppyyyyrrrreeeeqqqq((((DDDD4444))))
  71.  
  72.  
  73.  
  74.      The _cccc_qqqq______pppp_rrrr_iiii_vvvv_aaaa_tttt_eeee field is a field set aside for use by the driver.  It can
  75.      be used to hold whatever state information is necessary to process the
  76.      _iiii_oooo_cccc_tttt_llll.  It is copied to the _cccc_pppp______pppp_rrrr_iiii_vvvv_aaaa_tttt_eeee field in the resultant _MMMM______IIII_OOOO_CCCC_DDDD_AAAA_TTTT_AAAA
  77.      message.  When the _MMMM______CCCC_OOOO_PPPP_YYYY_IIII_NNNN or _MMMM______CCCC_OOOO_PPPP_YYYY_OOOO_UUUU_TTTT message is freed, any message
  78.      that _cccc_qqqq______pppp_rrrr_iiii_vvvv_aaaa_tttt_eeee refers to is not freed by the STREAMS subsystem.  It is
  79.      the responsibility of the module or driver to free it.
  80.  
  81. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  82.      _cccc_oooo_pppp_yyyy_rrrr_eeee_ssss_pppp(D4), _dddd_aaaa_tttt_aaaa_bbbb(D4), _iiii_oooo_cccc_bbbb_llll_kkkk(D4), _mmmm_eeee_ssss_ssss_aaaa_gggg_eeee_ssss(D5), _mmmm_ssss_gggg_bbbb(D4)
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.